revelplayer/com.reveldigital.player.view/[androidJvm]GadgetView

GadgetView

open class GadgetView : WebView, RevelControl, OnCommandListener

A custom WebView subclass designed to display "gadgets," which are typically web-based applications or content modules.

GadgetView configures a WebView with specific settings for optimal performance and compatibility with web content, including JavaScript execution, plugin support, and local storage. It interfaces with an external caching library (ren.yale.android.cachewebviewlib.WebViewCacheInterceptorInst) for custom caching behavior.

This view implements RevelControl for integration into a broader playback system and OnCommandListener to receive and relay commands to the loaded gadget via JavaScript. It also manages a list of OnCallbackListener instances to communicate events or data from the gadget back to interested components.

Gadgets are loaded from a specific URL pattern involving "shindig.reveldigital.com," with parameters derived from the provided Module object.

See also

OnCommandListener

OnCallbackListener

JavascriptInterfaceObject

WebViewCacheInterceptorInst

Constructors

constructor(context: Context, module: Module)

Constructs a new GadgetView.

Functions

addOnCallbackListener

open fun addOnCallbackListener(listener: OnCallbackListener)

Adds a listener to be notified of callbacks from the loaded gadget.

open fun dispose()

Performs cleanup operations for the GadgetView.

executeJavascript

open fun executeJavascript(script: String)

Executes the supplied JavaScript string within the context of the loaded web page.

open fun executeJavascript(script: String, @Nullable callback: ValueCallback<String>)

Executes the supplied JavaScript string within the context of the loaded web page and provides a callback for the result.

open fun getName(): String

Gets the unique name assigned to this control.

open fun getOptions(): Iterator<out Option>

Gets an iterator over the configuration s for this control.

open fun getPlaylist(): Playlist

Gets the associated with this control, if any.

open fun getType(): ModuleType

Gets the type of the underlying module or content associated with this control.

open fun getZIndex(): Int

Gets the Z-index (stacking order) of this control.

open fun initialize(module: Module)

Initializes the control with its associated module context.

open fun isAutoStart(): Boolean

Checks if this control is configured to start its operation automatically after #initialize(Module) initialization.

open fun isStarted(): Boolean

Checks if the control is currently in a started or active operational state.

open fun onCommand(name: String, value: String)

Invoked when a command is received by a component this listener is registered with.

@RequiresApi(api = Build.VERSION_CODES.KITKAT)

open fun print()

Initiates printing of the current web page content.

removeOnCallbackListener

open fun removeOnCallbackListener(listener: OnCallbackListener)

Removes a previously added OnCallbackListener.

open fun setAutoStart(flag: Boolean)

Sets whether this control should start its operation automatically after #initialize(Module) initialization.

open fun start()

Starts or resumes the active operation of this control.

open fun stop()

Stops or pauses the active operation of this control.